GetFile(IEasyUAFileTransfer,UAEndpointDescriptor,UANodeDescriptor,IReadOnlyList<String>,String) Method

Obtains a node descriptor of an OPC UA file object.

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
<ExtensionAttribute()>
Public Overloads Shared Function GetFile( _
   ByVal fileTransfer As IEasyUAFileTransfer, _
   ByVal endpointDescriptor As UAEndpointDescriptor, _
   ByVal directoryNodeDescriptor As UANodeDescriptor, _
   ByVal directoryPathElements As IReadOnlyList(Of String), _
   ByVal fileName As String _
) As ValueTuple(Of UANodeDescriptor,UANodeDescriptor)

'Usage
 
Dim fileTransfer As IEasyUAFileTransfer
Dim endpointDescriptor As UAEndpointDescriptor
Dim directoryNodeDescriptor As UANodeDescriptor
Dim directoryPathElements As IReadOnlyList(Of String)
Dim fileName As String
Dim value As ValueTuple(Of UANodeDescriptor,UANodeDescriptor)
 
value = IEasyUAFileTransferExtension.GetFile(fileTransfer, endpointDescriptor, directoryNodeDescriptor, directoryPathElements, fileName)

[Extension()]
public static ValueTuple<UANodeDescriptor,UANodeDescriptor> GetFile( 
   IEasyUAFileTransfer fileTransfer,
   UAEndpointDescriptor endpointDescriptor,
   UANodeDescriptor directoryNodeDescriptor,
   IReadOnlyList<string> directoryPathElements,
   string fileName
)

[Extension()]
public:
static ValueTuple<UANodeDescriptor^,UANodeDescriptor^> GetFile( 
   IEasyUAFileTransfer^ fileTransfer,
   UAEndpointDescriptor^ endpointDescriptor,
   UANodeDescriptor^ directoryNodeDescriptor,
   IReadOnlyList<String^>^ directoryPathElements,
   String^ fileName
)

Parameters

fileTransfer: The OPC UA file transfer object that will perform the operation.
endpointDescriptor: Endpoint descriptor. Identifies the OPC-UA server.
directoryNodeDescriptor: Node descriptor of the OPC UA directory.
directoryPathElements: A path consisting of names of subdirectories starting from directoryNodeDescriptor forwards.
fileName: The name of the file to be obtained.

Return Value

Returns a tuple consisting of a node descriptor of the parent directory, and a node descriptor of the file object found. The node descriptor of the file object is non-null.

Exceptions

Exception Description

Exception	Description
System.ArgumentNullException	A `null` reference (`Nothing` in Visual Basic) is passed to a method that does not accept it as a valid argument. This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.
OpcLabs.EasyOpc.UA.OperationModel.UAException	The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause. This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

System.ArgumentNullException

A null reference (Nothing in Visual Basic) is passed to a method that does not accept it as a valid argument.

This is a usage error, i.e. it will never occur (the exception will not be thrown) in a correctly written program. Your code should not catch this exception.

OpcLabs.EasyOpc.UA.OperationModel.UAException

The OPC UA operation has failed. This operation exception in uniformly used to allow common handling of various kinds of errors. The System.Exception.InnerException always contains information about the actual error cause.

This is an operation error that depends on factors external to your program, and thus cannot be always avoided. Your code must handle it appropriately.

Remarks

The directoryNodeDescriptor must be an existing node in the server, of object type OpcLabs.EasyOpc.UA.AddressSpace.Standard.UAObjectTypeIds.FileDirectoryType.

Requirements

Target Platforms: .NET Framework: Windows 10 (selected versions), Windows 11 (selected versions), Windows Server 2016, Windows Server 2022; .NET: Linux, macOS, Microsoft Windows

Reference

IEasyUAFileTransferExtension Class
IEasyUAFileTransferExtension Members
Overload List
FindFile Method
GetDirectory(IEasyUAFileTransfer,UAEndpointDescriptor,UANamedNodePath) Method
GetFileOrDirectory(IEasyUAFileTransfer,UAEndpointDescriptor,UANamedNodeDescriptor) Method
IsFile(IEasyUAFileTransfer,UAEndpointDescriptor,UANamedNodeDescriptor) Method

Send Documentation Feedback. Resources: Knowledge Base. Technical support: Online Forums, FAQ.